home *** CD-ROM | disk | FTP | other *** search
/ Aminet 39 / Aminet 39 (2000)(Schatztruhe)[!][Oct 2000].iso / Aminet / gfx / misc / imaged.lha / ImageDescriptor2.2 / Program / id2.txt < prev    next >
Encoding:
Text File  |  2000-08-03  |  15.2 KB  |  559 lines
  1. ;$VER: Image Descriptor TEXT Documentation 2.2 (02.08.2000)
  2.  
  3.  :: : Welcome to Image Descriptor 2 : ::
  4.  
  5. this is ASCI TXT Documentation v2.2
  6. date: 02.08.2000
  7.  
  8. Table of contents:
  9.  
  10.     introduction
  11.     disclaimer
  12.     copyrights
  13.     requirements
  14.     distribution
  15.     installation
  16.     usage
  17.     want to help me ?
  18.     misc infos
  19.     author
  20.  
  21. This documentation is 
  22. Copyrighted © 2000 by Tomasz Malerczyk. 
  23.  
  24. INTRODUCTION
  25. ------------
  26.  
  27. Image Descriptor 2 is small program with you can
  28. add your own description to images.
  29.  
  30. It supports Amiga IFF-ILBM images, and image formats
  31. used on World Wide Web: GIF (still and animated), PNG, JPEG
  32.  
  33. Few additional features:
  34.  
  35. - MUI user interface
  36. - removes any description already present in images
  37. - edit, change already present description (if any found)
  38.   and write it back to image
  39. - descripting all directories
  40.   (you can select whole directory content and program
  41.   will detect and load only supported images)
  42. - file comment support (user specified text, image based info
  43.   or it may clean up already present file comment)
  44. - shows to user few image informations (resolution, depth etc.)
  45. - datatypes not needed for loading and saving images
  46.   (so it should work with OS lower than 3.0)
  47. - viewing images with datatypes or external viewer
  48. - OpenURL library support (if installed) you can call Web Browser
  49.   to visit Web Site or e-mail author at any time
  50. - its very easy and its FREE!
  51.  
  52. DISCLAIMER
  53. ----------
  54.  
  55. The program Image Descriptor 2 is distributed "as is"
  56. and the author will not be responsible for any
  57. damage on either you, your computer or any data.
  58. This program is used entirely on YOUR own risk.
  59.  
  60. COPYRIGHTS
  61. ----------
  62.  
  63. Image Descriptor 2 and this manual is
  64. Copyrighted © 2000 by Tomasz Malerczyk.
  65.  
  66. MUI is Coprighted by Stefan Stuntz.
  67. Asm-Pro by Genetic.
  68. MUI Builder by Eric Totel.
  69. OpenUrl library by Troels Walsted Hansen.
  70. BetterString.mcc by Allan Odgaard
  71.  
  72. Image Descriptor 2 Web Site is hosted by
  73. http://www.promail.pl
  74. (free www and e-mail acounts)
  75. Image Descriptor 2 Web Site is powered by
  76. http://www.prv.pl
  77. (free www and e-mail aliases)
  78.  
  79. REQUIREMENTS
  80. ------------
  81.  
  82. Image Descriptor 2 is designed to work in
  83. Hires Interlaced (640x512) resolution
  84. or higher, but it should work in lower
  85. resolutions too.
  86.  
  87. Screenmode with 256 colors or more is also
  88. good idea. But it is not required, ID 2 will
  89. work on any screen depth.
  90. (for datatype viewing 256 or more colors
  91. mode is sugested).
  92.  
  93. Image Descriptor 2 should not be launched
  94. from CLI if stack size is lower than 8192 bytes.
  95.  
  96. Image Descriptor 2 requires:
  97.  
  98. - Magic User Interface (MUI) 3.8 or higher
  99. - asl.library
  100. - AmigaOS (should run on OS 2.0 or higher,
  101.   but not tested on OS 3.5)
  102. - some free memory
  103. - some images ...
  104.  
  105. If Image Descriptor 2 is unable to locate any of
  106. above (except images) or there is not enough memory
  107. it will exits silently without any message.
  108. Please remember that ...
  109.  
  110. Used but not required:
  111.  
  112. - more free memory (for big images)
  113. - hard disk
  114. - openurl.library (Web Browser and E-mail client)
  115. - BetterString.mcc
  116. - Dtpic.mui
  117. - datatypes (ILBM,GIF,JPEG,PNG)
  118. - image viewer
  119.  
  120. DISTRIBUTION
  121. ------------
  122.  
  123. Image Descriptor 2 is released as Mailware.
  124. It may be used, copied and spread as long as you want
  125. without taking any charge for it but you must send
  126. mail to author.
  127.  
  128. INSTALLATION
  129. ------------
  130.  
  131. Very easy! Just clik on Install icon and install
  132. script do all work.
  133.  
  134. You can uninstall it anytime using install script again.
  135.  
  136. Since verison 2.1, Installer will show you what version
  137. is currently installed and what version you are about
  138. to install. You can then install new version , uninstall
  139. previous or uninstall and install in one step.
  140. Note, that Install do NOT check version, it only
  141. show version number stored by previous Installer script.
  142. Decisions are up to you, so read carefuly what Installer
  143. says to you.
  144.  
  145. You can ofcourse execute Installer script for that same
  146. version, it is very comfortable way to move ID 2 files
  147. from one place to another (uninstall and install)
  148. still having possibility to automatically uninstall them
  149. by Install script.
  150.  
  151. Note for Image Descriptor 1 (which is obsolete !) users:
  152. First of all REMOVE THIS PIECE OF SHIT FROM YOUR SYSTEM :-)
  153. it have more bugs than W!ndoze (if its possible).
  154. And second, you must remove it manualy, this Install script
  155. will not do that.
  156.  
  157. USAGE
  158. -----
  159.  
  160. How to use Image Descriptor 2.
  161.  
  162. First of all you must know that ID 2 can work in two
  163. modes which are a little diffirent.
  164.  
  165. First mode (called SingleFile) is standard mode
  166. and it means that ONE image is loaded into memory
  167. and ID2 is operating on that image.
  168. You can add any description, view info or show
  169. that image and then save it.
  170.  
  171. Second mode (called MultiFile) is enblad when you
  172. select MORE than one file from file requester.
  173. ID 2 will then remember all file names you`ve selected.
  174. When ID 2 is working in MultiFile mode you can`t
  175. view image info or show image becouse there are
  176. too much images and that images are not in memory.
  177. So what you can?
  178. You can add description to that images.
  179. After that you can save that images.
  180. ID 2 will load, describe and save all images one by one
  181. depending on image format you`ve selected. (explained below)
  182.  
  183. To do all this stuff look at ID 2 window which consist
  184. of five pages: FILE, NOTE, INFO, VIEW, ABOUT.
  185.  
  186. The first page is ...
  187.  
  188. File page
  189.  
  190. First group on that page is File info which consist of
  191. NAME, TYPE and  SIZE labels.
  192.  
  193. NAME:
  194. (SingleFile) name of image loaded into memory
  195. (MulitFile) "MultiFile Mode" when working in
  196.  
  197. TYPE:
  198. (SingleFile) type of loaded image
  199. [ ILBM, GIF, PNG, JPEG ]
  200. (MultiFile) word "MULTI"
  201.  
  202. SIZE:
  203.  (SingleFile) size od loaded image in bytes
  204. (MultiFile) number of selected images
  205.  
  206. Next group is only available when working in
  207. MultiFile mode.
  208. You can select here which image format will
  209. be accepted when loading and saving images.
  210. You can select whole directory content not
  211. matter that there are images, binary files
  212. or text files. ID 2 will check all files
  213. and load only that you choose here.
  214. This selection is ignored when ID 2 cleans images
  215.  
  216. Next is File Comment group. Here you can make
  217. some selections for file comment operations.
  218.  
  219. That options are checked only when ID 2 saving images
  220. except  CLEAN UP which is also checked when ID 2 cleans
  221. images
  222.  
  223. There are four choices.
  224.  
  225. DON`T CHANGE:
  226. file comment will not be changed for existing
  227. files and will not be added for new files
  228.  
  229. BASED ON IMAGE INFO:
  230. file comment will be created from image info
  231. and will look like this example:
  232. ILBM - 00640 x 00512 - 256
  233. which means that it is ILBM image with
  234. resolution 640 x 512 and 256 colors
  235.  
  236. USER SPECIFIED TEXT:
  237. an additional string gadget will be enable
  238. and you can type you own text
  239.  
  240. CLEAN UP
  241. any existing file comment will be erased
  242.  
  243. That options are valid for both SingleFile and
  244. MultiFile mode.
  245.  
  246. And finally there are four buttons.
  247.  
  248. OPEN
  249. when you click it a file requester will show up
  250. and you can selected one or more files
  251.  
  252. on right side of "Open" word on this button
  253. is standard MUI PopUp image, when you click
  254. it additional button will popup below Open
  255. button which contains path of last save dir.
  256. this path is stored in file called "lastdir"
  257. in "ENV:ImageDescriptor" and is created
  258. after first use of Save button and is loaded
  259. only when ID 2 starts.
  260.  
  261. if ID 2 is in MultiFile it swith itself to
  262. SingleFile mode asking you before that.
  263.  
  264. if image appears to corrupted or is not
  265. recognized ID 2 will tell you about that
  266.  
  267. if there is not enough memory to load image
  268. ID 2 will tell you about that
  269.  
  270.  
  271. PASTE
  272. second button allow you to paste image from
  273. clipboard. it is very useful when you just
  274. painted some image and you want to save it
  275. as brush. now you can just copy this brush to
  276. clipboard and paste it directly to ID 2,
  277. describe it and save to disk.
  278. only thing you must know is that system
  279. stores images in clipboard in ILBM format
  280. so you can save it only in this format
  281. from ID 2
  282. default name for that image is "Clipboard.iff"
  283.  
  284. if ID 2 is in MultiFile it swith itself to
  285. SingleFile mode asking you before that.
  286.  
  287. if image appears to corrupted or clipboard
  288. not contains image ID 2 will tell you about that
  289.  
  290. if there is not enough memory to load image
  291. ID 2 will disable all pages just like no image
  292. is loaded
  293.  
  294. SAVE
  295. with this button you may save images to disk.
  296. this button is disabled as long as you type
  297. something on Note page (see below)
  298.  
  299. (SingleFile) a file requester will show up
  300. and you can select dir and filename
  301. if file already exists you may choose
  302. if you want to overwrite it or not
  303.  
  304. if for some reason ID 2 will be unable to
  305. save image it will tell you about that
  306.  
  307. (MultiFile) a file requester will show up
  308. and you can select only dir
  309. then all images will be saved into that dir
  310.  
  311. if files already exists you may choose
  312. if you want to overwrite it or not
  313.  
  314. if for some reason ID 2 will be unable to
  315. load or save images it will tell you about that
  316.  
  317. When image is saved ID 2 checks File Comment
  318. options and file comment is added or not
  319. (both for SingleFile and MultiFile modes)
  320.  
  321. file comment errors are not checked
  322.  
  323. CLEAN UP
  324. this works like save except:
  325. - all descriptions all removed
  326. - file comment is cleared if CLEAN UP is
  327.   selected in File Comment options
  328.   otherwise file comment is not changed
  329.  
  330. error handling is identical to save
  331.  
  332. For all file operations a window is opened
  333. with progress bar and main window is frozen
  334. (in case you have weird ideas :-)
  335.  
  336. (MultiFile) additional for MultiFile mode an Abort
  337. button is available allowing you to cancel load/save
  338. process in any moment
  339.  
  340. Note page
  341.  
  342. This is second page. Its content depends on image type
  343. you loaded or selected via cycle gadget on File page.
  344.  
  345. ILBM:
  346. there are four string gadgets available
  347. Title, Author, Copyrights, Annotation
  348. you can edit any of them or all
  349. empty gadgets are ignored when saving
  350. you must type a least one letter to enable
  351. Save button
  352.  
  353. all string are limited to 256 characters for now
  354. (even if PNG and ILBM image format can handle
  355. up to 16 milions of characters, JPEG 65535 characters
  356. and GIF unlimited blocks of 256 characters)
  357.  
  358. you don`t need to press Enter at end of typing
  359.  
  360. by pressing Tab you can go to next string gadget
  361.  
  362. PNG:
  363. there are five string gadgets available
  364. Title, Author, Copyrights, Comment, Software
  365. but you can edit only four of them
  366.  
  367. Software gadget is read only
  368.  
  369. rest is the same as for ILBM
  370.  
  371. GIF:
  372. there is only  Comment string gadget available
  373.  
  374. rest is the same as for ILBM
  375.  
  376. JPEG:
  377. there is also one string gadget available
  378.  
  379. rest is the same as for ILBM
  380.  
  381. If you have BetterString.mcc class installed ID 2
  382. will automatically make use of it.
  383. You can use Copy/Paste features of this class.
  384.  
  385. Otherwise standard String class will be used.
  386.  
  387. Info page
  388.  
  389. On this page you can read some informations about
  390. loaded image. Most of that infos are the same for
  391. diffirent image type but few of them are specifc
  392. to image type.
  393.  
  394. Few hints ...
  395. for GIF:
  396. - if it`s GIF 89a and Application extension
  397.   is NETSCAPE2.0 you may be sure that it`s
  398.   animated GIF
  399. - GIF 87a can`t be descibed so ID 2 will
  400.   write it as GIF 89a
  401. for ILBM:
  402. - if image size is smaller than screen size
  403.   it`s propably brush
  404. - Amiga interlace has nothing to do with
  405.   GIF interlace (called also progressive)
  406. for JPEG:
  407. - if number of colors equal to 256 that you
  408.   may be sure that this is greyscaled image
  409. - JFIF extension segment is only valid for
  410.   version 1.02 and it contains thumbnail
  411. - even version 1.01 can have thumbnail
  412.   without JFIF extension segment
  413.   ID 2 tell you its size if it find thumbnail
  414. for PNG:
  415. - PNG is designed to replace GIF
  416. - it can provide many infos not available
  417.   for above image format like Chromma and
  418.   Gamma infos
  419.  
  420. This page is not available in MultiFile mode.
  421.  
  422. View page
  423.  
  424. For your enjoyment ID 2 provide View option.
  425. If you are lucky owner of AmigaOS 3.0 or higher
  426. ID 2 will make use of datatype system available
  427. on that systems (if you have Dtpic.mui class
  428. installed which is part of MUI 3.8)
  429.  
  430. Just click View button and wait untill datatypes
  431. are done with image.
  432.  
  433. If an empty window popup it means:
  434. - there is not enough memory
  435. - image is in High or True color, you have 8 bit
  436.   screenmode and you datatypes are unable
  437.   to load 24 bit images
  438.   in that case try to install diffirent datatypes
  439.   (try use that which comes with Picasso96 software)
  440. - or aliens erases that image before datatypes
  441.   load it
  442.  
  443. VERY IMPORTANT NOTE!
  444. Datatypes loads images from disk. If you load image
  445. into memory with ID 2 datatypes still needs that image
  446. on disk.
  447.  
  448. DON`T TRY TO LOAD IMAGE THEN SILENTLY DELETE IT VIA
  449. SOME FILE MANAGERS AND THEN TRY TO VIEW IT
  450. THAT WON`T WORK
  451.  
  452. As far i know only OS3.5 datatypes are able to
  453. access image stored in memory, but either MUI and
  454. ID 2 doesn`t support OS 3.5 datatypes.
  455. MUI becouse it was written before OS 3.5 and
  456. ID 2 becouse it uses MUI.
  457.  
  458. Dtpic.mui is required becouse standard Image class
  459. has bug and "forgets" to unlock file after using it.
  460.  
  461. If datatypes are not available ID 2 should disable
  462. View button.
  463.  
  464. If you arent lucky you don`t need to worry.
  465. ID 2 can show you image using external viewer.
  466.  
  467. To do that you need external viewer (like Visage
  468. or ViewTek). Click Select button and file requester
  469. will popup, you can then select your viewer.
  470. ID 2 will call it with image full path as parameter.
  471.  
  472. Example:
  473.  
  474. You loaded "Myphoto.jpg" from "Work:pictures"
  475. and you selected "Visage" as you viewer which is
  476. located in "System:tools".
  477.  
  478. ID 2 will execute following AmigaDOS command:
  479. "System:tools/Visage" "Work:pictures/Myphoto.jpg"
  480.  
  481. so again ... DON`T TRY TO DELETE IMAGE AFTER LOADING IT TO
  482. ID 2 AND THEN TO VIEW IT
  483.  
  484. This page is not available in MultiFile mode and
  485. in SingleFile mode if image was pasted from clipboard
  486.  
  487. (maybe next version will be able to view image even
  488. if it`s pasted from clipboard via iffparse.library
  489. and datatypes system)
  490.  
  491. About page
  492.  
  493. This page is not very useful itself but you can
  494. read here how to contact with me.
  495.  
  496. Also you can check what version of ID 2 you have.
  497.  
  498. And last at the bottom of this page is placed
  499. internet adress together with e-mail adress.
  500. If you click one of them ID 2 will call openurl.library
  501. and if it`s installed a Web Browser or Email Client
  502. will be launched.
  503.  
  504. ID 2 automatically sets Subject for e-mail to version number.
  505. It`s done for two purposes:
  506. - i know what version of ID you have
  507. - i can count how many peoples writes e-mail to
  508.   me directly from program and how many via Web Site
  509.  
  510. WANT TO HELP ME ?
  511. -----------------
  512.  
  513. You may ask "how can i help ?", the answer is ...
  514.  
  515. If you have image that you can`t load with ID 2 or can`t
  516. save it or can save it but can`t display it later or
  517. (i hope not) image that make ID 2 freeze and you are
  518. sure that this image is viewable with other software
  519. please send it to me.
  520.  
  521. Also, if you have JPEG image with thumbnail inside
  522. (version 1.01 not 1.02) please send it to me.
  523. You can check if thumbnail is inside by checking
  524. 18 and 19 byte of image. If they are diffirent than
  525. ZERO you may be sure that there is thumbnail.
  526.  
  527. AUTHOR
  528. ------
  529.  
  530. If you want more infos or only say how
  531. beatiful is this program and how much
  532. you like it :-) ...
  533.  
  534. Feel free to write to:
  535.  
  536. Tomasz Malerczyk
  537. ul.Szczesliwa 10/3
  538. 41-506 Chorzow
  539. Poland
  540.  
  541. or e-mail: feedback@imagedescriptor.prv.pl 
  542.  
  543. IRC Nickname:  Vepar (on IRCNet)
  544.  
  545. internet: http://www.imagedescriptor.prv.pl/ 
  546.  
  547. Any suggestions are welcome together with bug reports.
  548. Especially MC68030 and above users with Enforcer like
  549. software installed.
  550.  
  551. SOME MISC INFOS
  552. ---------------
  553.  
  554. ID2 - Image Descriptor 2
  555.  
  556. IFF-ILBM - Interchange File Format InterLeaved BitMap
  557. GIF - Graphics Interchamge Format
  558. PNG - Portable Network Graphics
  559. JPEG-JFIF - JPEG File Interchange Format